From 9e261027047c43694ff40159be2fe219aeb9486d Mon Sep 17 00:00:00 2001 From: =?utf8?q?Javier=20Jard=C3=B3n?= Date: Wed, 13 Apr 2011 14:36:28 +0100 Subject: [PATCH] Move documentation to inline comments: GtkColorSelectionDialog --- docs/reference/gtk/tmpl/.gitignore | 1 + docs/reference/gtk/tmpl/gtkcolorseldlg.sgml | 117 -------------------- gtk/gtkcolorseldialog.c | 33 ++++++ 3 files changed, 34 insertions(+), 117 deletions(-) delete mode 100644 docs/reference/gtk/tmpl/gtkcolorseldlg.sgml diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 61ff64e232..ae6f64520c 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -24,6 +24,7 @@ gtkcheckmenuitem.sgml gtkclipboard.sgml gtkcolorbutton.sgml gtkcolorsel.sgml +gtkcolorseldlg.sgml gtkcombobox.sgml gtkcomboboxentry.sgml gtkcontainer.sgml diff --git a/docs/reference/gtk/tmpl/gtkcolorseldlg.sgml b/docs/reference/gtk/tmpl/gtkcolorseldlg.sgml deleted file mode 100644 index 793cacbebb..0000000000 --- a/docs/reference/gtk/tmpl/gtkcolorseldlg.sgml +++ /dev/null @@ -1,117 +0,0 @@ - -GtkColorSelectionDialog - - -A standard dialog box for selecting a color - - - -The #GtkColorSelectionDialog provides a standard dialog which -allows the user to select a color much like the #GtkFileSelection -provides a standard dialog for file selection. - - - -GtkColorSelectionDialog as GtkBuildable - -The GtkColorSelectionDialog implementation of the GtkBuildable interface -exposes the embedded #GtkColorSelection as internal child with the -name "color_selection". It also exposes the buttons with the names -"ok_button", "cancel_button" and "help_button". - - - - - - - - - - - - - - - - -The #GtkColorSelectionDialog-struct struct contains the following fields. -(These fields should be considered read-only. They should never be set by -an application.) - - - - - - -#GtkWidget *colorsel; -The #GtkColorSelection widget contained within the -dialog. Use this widget and its gtk_color_selection_get_current_color() -function to gain access to the selected color. Connect a handler -for this widget's color_changed signal to be notified when the -color changes. - - - - -#GtkWidget *ok_button; -The OK button widget contained within the dialog. -Connect a handler for the clicked event. - - - - -#GtkWidget *cancel_button; -The cancel button widget contained within the dialog. -Connect a handler for the clicked event. - - - - -#GtkWidget *help_button; -The help button widget contained within the dialog. -Connect a handler for the clicked event. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Creates a new #GtkColorSelectionDialog. - - -@title: a string containing the title text for the dialog. -@Returns: a #GtkColorSelectionDialog. - - - - - - - -@colorsel: -@Returns: - - diff --git a/gtk/gtkcolorseldialog.c b/gtk/gtkcolorseldialog.c index 7a729ec97f..4d0f678b32 100644 --- a/gtk/gtkcolorseldialog.c +++ b/gtk/gtkcolorseldialog.c @@ -35,6 +35,31 @@ #include "gtkbuildable.h" +/** + * SECTION:gtkcolorseldlg + * @Short_description: A standard dialog box for selecting a color + * @Title: GtkColorSelectionDialog + * + * The #GtkColorSelectionDialog provides a standard dialog which + * allows the user to select a color much like the #GtkFileSelection + * provides a standard dialog for file selection. + * + * Use gtk_color_selection_dialog_get_color_selection() to get the + * #GtkColorSelection widget contained within the dialog. Use this widget + * and its gtk_color_selection_get_current_color() + * function to gain access to the selected color. Connect a handler + * for this widget's #GtkColorSelection::color-changed signal to be notified + * when the color changes. + * + * + * GtkColorSelectionDialog as GtkBuildable + * The GtkColorSelectionDialog implementation of the GtkBuildable interface + * exposes the embedded #GtkColorSelection as internal child with the + * name "color_selection". It also exposes the buttons with the names + * "ok_button", "cancel_button" and "help_button". + * + */ + struct _GtkColorSelectionDialogPrivate { @@ -189,6 +214,14 @@ gtk_color_selection_dialog_init (GtkColorSelectionDialog *colorseldiag) _("Color Selection")); } +/** + * gtk_color_selection_dialog_new: + * @title: a string containing the title text for the dialog. + * + * Creates a new #GtkColorSelectionDialog. + * + * Returns: a #GtkColorSelectionDialog. + */ GtkWidget* gtk_color_selection_dialog_new (const gchar *title) { -- 2.30.2